docs: Fix regex matching security issue in shell whitelist#68
Closed
ammario wants to merge 4 commits into
Closed
Conversation
Added three new pattern examples to the JavaScript rule engine documentation: - Host whitelist pattern - Combined host + method whitelist - Regexp matching for method + URL combinations Also cleaned up duplicate javascript-rules.md file. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Enhanced the shell script documentation with a practical example showing: - httpjail command usage - External whitelist.txt file for managing allowed domains - Shell script that reads and validates against the whitelist This provides a more maintainable approach for domain filtering compared to hardcoding domains in the script. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
The previous grep pattern treated dots as regex wildcards, which could
allow unintended domains like "apiXgithubYcom" to match "api.github.com".
Changed from grep -q "^${HTTPJAIL_HOST}$" to grep -Fxq for literal matching:
- F: Fixed strings (literal match, no regex)
- x: Match whole lines exactly
- q: Quiet mode
This ensures only exact domain matches are allowed, preventing security issues
from regex interpretation of special characters.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes a security vulnerability in the shell whitelist documentation example where dots in domain names were treated as regex wildcards.
Problem
The previous example used
grep -q "^${HTTPJAIL_HOST}$"which treats each line in whitelist.txt as a regular expression. This meansapi.github.comwould match unintended hosts likeapiXgithubYcomsince dots are regex wildcards.Solution
Changed to
grep -Fxq "$HTTPJAIL_HOST"for literal string matching:Security Impact
This ensures only exact domain matches are allowed, preventing potential bypass of domain restrictions through regex pattern matching.
Test plan
🤖 Generated with Claude Code